home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / time / Time_ToAscii.man < prev    next >
Encoding:
Text File  |  1990-11-28  |  1.5 KB  |  47 lines
  1. ' $Header: /sprite/src/lib/c/time/RCS/Time_ToAscii.man,v 1.3 90/11/27 16:04:18 kupfer Exp $ SPRITE (Berkeley)
  2. '
  3. '  ROUGH DRAFT!!!
  4. '
  5. .so \*(]ltmac.sprite
  6. .HS Time_ToAscii lib
  7. .BS
  8. .SH NAME
  9. Time_ToAscii, Time_FromAscii, Time_ToParts, Time_FromParts \- time conversion routines
  10. .SH SYNOPSIS
  11. .nf
  12. \fB#include <spriteTime.h>\fR
  13.  
  14. \fBTime_ToAscii\fR(\fIseconds, isInterval, bufferPtr\fR)
  15.  
  16. \fBTime_FromAscii\fR(\fIbufferPtr, timePtr\fR)
  17.  
  18. \fBTime_ToParts\fR(\fIseconds, isInterval, partsPtr\fR)
  19.  
  20. \fBTime_FromParts\fR(\fIpartsPtr, isInterval, secondsPtr\fR)
  21. .SH ARGUMENTS
  22. .AP int seconds in
  23. A time value in seconds to be converted to Ascii.
  24. .AP Boolean isInterval in
  25. If TRUE, interpret the time as a time interval.
  26. .AP char *bufferPtr out,in
  27. A buffer to hold the converted time.
  28. .AP Time *timePtr out
  29. Buffer to hold a time value  converted from Ascii.
  30. .AP Time_Parts partsPtr in/out
  31. Buffer to contain  the decomposed time values.
  32. .AP int *secondsPtr out
  33. Place to store time value converted from parts.
  34.  
  35. .BE
  36. .SH DESCRIPTION
  37. The \fBTime_ToAscii\fR and \fBTime_FromAscii\fR procedures convert a time value in
  38. seconds to and from Ascii. \fBTime_ToParts\fR converts a time value in seconds into
  39. the year, month, day of year, day of month,m day of week, hours, minutes, 
  40. and seconds. 
  41. \fBTime_FromParts\fR converts a time value from its parts to seconds.
  42. Don't give it a date before January 1, 1970 and make sure that the day
  43. of year corresponds to the month and day of month values.
  44. An interval is the difference between two times.
  45. .SH KEYWORDS
  46. ascii, time
  47.